<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>src.processing.planning_time.Planning_time</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="src-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >ttrq4fleet - Petrina Papazek</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="src-module.html">Package&nbsp;src</a> ::
        <a href="src.processing-module.html">Package&nbsp;processing</a> ::
        <a href="src.processing.planning_time-module.html">Module&nbsp;planning_time</a> ::
        Class&nbsp;Planning_time
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="src.processing.planning_time.Planning_time-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Planning_time</h1><p class="nomargin-top"><span class="codelink"><a href="src.processing.planning_time-pysrc.html#Planning_time">source&nbsp;code</a></span></p>
<center>
<center>  <map id="uml_class_diagram_for_src_proc_16" name="uml_class_diagram_for_src_proc_16">
<area shape="rect" href="src.processing.indicator.Indicator-class.html#name" title="src.processing.indicator.Indicator.name" alt="" coords="20,28,175,47"/>
<area shape="rect" href="src.processing.indicator.Indicator-class.html#mr_name" title="src.processing.indicator.Indicator.mr_name" alt="" coords="20,47,175,65"/>
<area shape="rect" href="src.processing.indicator.Indicator-class.html#get_name" title="src.processing.indicator.Indicator.get_name" alt="" coords="20,68,175,87"/>
<area shape="rect" href="src.processing.indicator.Indicator-class.html#get_mr_name" title="src.processing.indicator.Indicator.get_mr_name" alt="" coords="20,87,175,105"/>
<area shape="rect" href="src.processing.indicator.Indicator-class.html#export2csv" title="uses a given csv&#45;writer&#45;object (@see output CSV_export) in export the &#160;indicator to csv." alt="" coords="20,105,175,124"/>
<area shape="rect" href="src.processing.indicator.Indicator-class.html" title="this class is abstract and represents one indicator." alt="" coords="19,11,176,125"/>
<area shape="rect" href="src.processing.link_indicator.Link_indicator-class.html" title="this class is abstract and represents one indicator for one Link." alt="" coords="16,155,179,187"/>
<area shape="rect" href="src.processing.planning_time.Planning_time-class.html#__init__" title="x.__init__(...) initializes x; see x.__class__.__doc__ for signature" alt="" coords="37,241,157,260"/>
<area shape="rect" href="src.processing.planning_time.Planning_time-class.html#calculate" title="Returns: &#160;planning time for every time interval as list of Result_values" alt="" coords="37,260,157,279"/>
<area shape="rect" href="src.processing.planning_time.Planning_time-class.html#plot" title="plots the planning time and the aggregated data" alt="" coords="37,279,157,297"/>
<area shape="rect" href="src.processing.planning_time.Planning_time-class.html" title="Calculates the planning time for every time interval (using aggregated fcd&#45;data)." alt="" coords="36,216,159,299"/>
</map>
  <img src="uml_class_diagram_for_src_proc_16.gif" alt='' usemap="#uml_class_diagram_for_src_proc_16" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>Calculates the planning time for every time interval (using aggregated
  fcd-data).</p>
  <p>The planning time is a kind of worst case travel time, e.g. which 
  travel time does a commuter need to reach his/her destination in 95% of 
  the cases. Therefore the planing time is equal to the 95th percentile of 
  the travel times of a interval. The indicator calculates the planing time
  for each interval.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="src.processing.planning_time.Planning_time-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">link</span>)</span><br />
      x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="src.processing.planning_time-pysrc.html#Planning_time.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="src.processing.planning_time.Planning_time-class.html#calculate" class="summary-sig-name">calculate</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Returns:
      planning time for every time interval as list of Result_values</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="src.processing.planning_time-pysrc.html#Planning_time.calculate">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="src.processing.planning_time.Planning_time-class.html#plot" class="summary-sig-name">plot</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">plotobject</span>)</span><br />
      plots the planning time and the aggregated data</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="src.processing.planning_time-pysrc.html#Planning_time.plot">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="src.processing.link_indicator.Link_indicator-class.html">link_indicator.Link_indicator</a></code></b> (private):
      <code><a href="src.processing.link_indicator.Link_indicator-class.html#_create_title" onclick="show_private();">_create_title</a></code>,
      <code><a href="src.processing.link_indicator.Link_indicator-class.html#_plot_data" onclick="show_private();">_plot_data</a></code>
      </p></div>
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="src.processing.indicator.Indicator-class.html">indicator.Indicator</a></code></b>:
      <code><a href="src.processing.indicator.Indicator-class.html#export2csv">export2csv</a></code>,
      <code><a href="src.processing.indicator.Indicator-class.html#get_mr_name">get_mr_name</a></code>,
      <code><a href="src.processing.indicator.Indicator-class.html#get_name">get_name</a></code>
      </p>
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="src.processing.indicator.Indicator-class.html">indicator.Indicator</a></code></b> (private):
      <code><a href="src.processing.indicator.Indicator-class.html#_create_plot" onclick="show_private();">_create_plot</a></code>,
      <code><a href="src.processing.indicator.Indicator-class.html#_plot_big_pnt" onclick="show_private();">_plot_big_pnt</a></code>,
      <code><a href="src.processing.indicator.Indicator-class.html#_plot_period" onclick="show_private();">_plot_period</a></code>
      </p></div>
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__format__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__sizeof__</code>,
      <code>__str__</code>,
      <code>__subclasshook__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Class Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-ClassVariables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="src.processing.indicator.Indicator-class.html">indicator.Indicator</a></code></b>:
      <code><a href="src.processing.indicator.Indicator-class.html#mr_name">mr_name</a></code>,
      <code><a href="src.processing.indicator.Indicator-class.html#name">name</a></code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">link</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="src.processing.planning_time-pysrc.html#Planning_time.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>x.__init__(...) initializes x; see x.__class__.__doc__ for 
  signature</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>link</code></strong> - Link-object (containing valid records and timeseries)</li>
    </ul></dd>
    <dt>Overrides:
        object.__init__
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="calculate"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">calculate</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="src.processing.planning_time-pysrc.html#Planning_time.calculate">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>abstract polymorph method in order to calculate and return the 
  indicator values. The calculated values are written to the protected 
  field self._values. After calculating the values, the method returns a 
  reference to this field.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>planning time for every time interval as list of Result_values</dd>
    <dt>Overrides:
        <a href="src.processing.indicator.Indicator-class.html#calculate">indicator.Indicator.calculate</a>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="plot"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">plot</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">plotobject</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="src.processing.planning_time-pysrc.html#Planning_time.plot">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>plots the planning time and the aggregated data</p>
  <dl class="fields">
    <dt>Overrides:
        <a href="src.processing.indicator.Indicator-class.html#plot">indicator.Indicator.plot</a>
    </dt>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="src-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >ttrq4fleet - Petrina Papazek</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Thu Oct 25 19:15:42 2012
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
